ibm-cloud-sdk-core

What is ibm-cloud-sdk-core?

The ibm-cloud-sdk-core npm package provides core functionality for IBM Cloud SDKs, including authentication, request handling, and utility functions. It is used as a foundational library for building and interacting with IBM Cloud services.

What are ibm-cloud-sdk-core's main functionalities?

Authentication

The package provides various authenticators, such as IAM, to handle authentication with IBM Cloud services. This code sample demonstrates how to create an IAM authenticator using an API key.

const { IamAuthenticator } = require('ibm-cloud-sdk-core');
const authenticator = new IamAuthenticator({ apikey: 'your-iam-api-key' });

Request Handling

The package provides a BaseService class to facilitate making HTTP requests to IBM Cloud services. This code sample shows how to extend BaseService to create a custom service with a method that makes a GET request.

const { BaseService } = require('ibm-cloud-sdk-core');
class MyService extends BaseService {
  constructor(options) {
    super(options);
  }
  myMethod() {
    const parameters = {
      options: {
        url: '/v1/resource',
        method: 'GET',
      },
      defaultOptions: this.baseOptions,
    };
    return this.createRequest(parameters);
  }
}

Utility Functions

The package includes utility functions like getSdkHeaders to generate standard headers for SDK requests. This code sample demonstrates how to use getSdkHeaders to create headers for a specific service operation.

const { getSdkHeaders } = require('ibm-cloud-sdk-core');
const headers = getSdkHeaders('service-name', 'service-version', 'operation-id');

Other packages similar to ibm-cloud-sdk-core

aws-sdk

The aws-sdk package is the official SDK for AWS services, providing similar functionalities such as authentication, request handling, and utility functions for interacting with AWS services. It is comparable to ibm-cloud-sdk-core in terms of providing foundational support for cloud service interactions, but it is specific to AWS.

google-auth-library

The google-auth-library package provides authentication support for Google Cloud services. It offers similar authentication functionalities as ibm-cloud-sdk-core but is tailored for Google Cloud's authentication mechanisms.

azure-sdk-for-js

The azure-sdk-for-js is a collection of libraries for interacting with Azure services. It provides similar core functionalities like authentication and request handling, akin to ibm-cloud-sdk-core, but is designed for use with Microsoft Azure services.

README

The README file is missing